home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 41 / Amiga Format CD41 (1999-06)(Future Publishing)(GB)[!][issue 1999-07].iso / -seriously_amiga- / programming / other / scm / slib / readme < prev    next >
Text File  |  1999-04-19  |  12KB  |  248 lines
  1. This directory contains the distribution of Scheme Library slib2c5.
  2. Slib conforms to Revised^5 Report on the Algorithmic Language Scheme
  3. and the IEEE P1178 specification.  Slib supports Unix and similar
  4. systems, VMS, and MS-DOS.
  5.  
  6. The maintainer can be reached at jaffer @ ai.mit.edu.
  7.         http://swissnet.ai.mit.edu/~jaffer/SLIB.html
  8.  
  9.                    MANIFEST
  10.  
  11.   `README' is this file.  It contains a MANIFEST, INSTALLATION
  12.     INSTRUCTIONS, and proposed coding standards.
  13.   `FAQ' Frequently Asked Questions and answers.
  14.   `ChangeLog' documents changes to slib.
  15.   `slib.texi' has documentation on library packages in TexInfo format.
  16.  
  17.   `Template.scm' Example configuration file.  Copy and customize to
  18.     reflect your system.
  19.   `chez.init' is a configuration file for Chez Scheme.
  20.   `elk.init' is a configuration file for ELK 2.1
  21.   `gambit.init' is a configuration file for Gambit Scheme.
  22.   `macscheme.init' is a configuration file for MacScheme.
  23.   `mitscheme.init' is a configuration file for MIT Scheme.
  24.   `mitcomp.pat' is a patch file which adds definitions to SLIB files
  25.     for the MitScheme compiler.
  26.   `pscheme.init' is configuration file for PocketScheme 0.2.5 (WinCE SIOD)
  27.   `RScheme.init' is a configuration file for RScheme.
  28.     `scheme2c.init' is a configuration file for DEC's scheme->c.
  29.   `scheme48.init' is a configuration file for Scheme48.
  30.   `scsh.init' is a configuration file for Scheme-Shell
  31.   `scm.init' is a configuration file for SCM.
  32.   `t3.init' is a configuration file for T3.1 in Scheme mode.
  33.   `STk.init' is a configuration file for STk.
  34.   `umbscheme.init' is a configuration file for umb-scheme.  
  35.   `vscm.init' is a configuration file for VSCM.
  36.   `mklibcat.scm' builds the *catalog* cache.
  37.   `require.scm' has code which allows system independent access to
  38.     the library files.
  39.  
  40.   `Bev2slib.scm' Converts Stephen Bevan's "*.map" files to SLIB catalog entries.
  41.   `format.scm' has Common-Lisp style format.
  42.   `formatst.scm' has code to test format.scm
  43.   `pp.scm' has pretty-print.
  44.   `ppfile.scm' has pprint-file and pprint-filter-file.
  45.   `obj2str.scm' has object->string.
  46.   `strcase.scm' has functions for manipulating the case of strings.
  47.   `genwrite.scm' has a generic-write which is used by pp.scm,
  48.     pp2str.scm and obj2str.scm
  49.   `printf.scm' has printf, fprintf, and sprintf compatible with C.
  50.   `scanf.scm' has scanf, fscanf, and sscanf compatible by C.
  51.   `lineio' has line oriented input/output functions.
  52.   `qp.scm' has printer safe for circular structures.
  53.   `break.scm' has break and continue.
  54.   `trace.scm' has trace and untrace for tracing function execution.
  55.   `debug.scm' has handy higher level debugging aids.
  56.   `strport.scm' has routines for string-ports.
  57.   `strsrch.scm' search for chars or substrings in strings and ports.
  58.  
  59.   `alist.scm' has functions accessing and modifying association lists.
  60.   `hash.scm' defines hash, hashq, and hashv.
  61.   `hashtab.scm' has hash tables.
  62.   `sierpinski.scm' 2-dimensional coordinate hash.
  63.   `soundex.scm' English name hash.
  64.   `logical.scm' emulates 2's complement logical operations.
  65.   `random.scm' has random number generator compatible with Common Lisp.
  66.   `randinex.scm' has inexact real number distributions.
  67.   `primes.scm' has primes and probably-prime?.
  68.   `factor.scm' has factor.
  69.   `root.scm' has Newton's and Laguerre's methods for finding roots.
  70.   `cring.scm' extend + and * to custom commutative rings.
  71.   `selfset.scm' sets single letter identifiers to their symbols.
  72.   `determ.scm' compute determinant of list of lists.
  73.   `charplot.scm' has procedure for plotting on character screens.
  74.   `plottest.scm' has code to test charplot.scm.
  75.   `tek40.scm' has routines for Tektronix 4000 series graphics.
  76.   `tek41.scm' has routines for Tektronix 4100 series graphics.
  77.   `getopt.scm' has posix-like getopt for parsing command line arguments. 
  78.   `psxtime.scm' has Posix time conversion routines.
  79.   `cltime.scm' has Common-Lisp time conversion routines.
  80.   `timezone.scm' has the default time-zone, UTC.
  81.   `tzfile.scm' reads sysV style (binary) timezone file.
  82.   `comparse.scm' has shell-like command parsing.
  83.  
  84.   `rdms.scm' has code to construct a relational database from a base
  85.     table implementation.
  86.   `alistab.scm' has association list base tables.
  87.   `dbutil.scm' has utilities for creating and manipulating relational
  88.     databases.
  89.   `htmlform' generates HTML2.0 forms and service CGI requests from RDB
  90.     command tables.
  91.   `dbrowse.scm' browses relational databases.
  92.   `paramlst.scm' has procedures for passing parameters by name.
  93.   `getparam.scm' has procedures for converting getopt to parameters.
  94.   `report.scm' prints database reports.
  95.   `schmooz.scm' is a simple, lightweight markup language for
  96.     interspersing Texinfo documentation with Scheme source code.
  97.   `glob.scm' has filename matching and manipulation.
  98.   `batch.scm' Group and execute commands on various operating systems.
  99.   `makcrc.scm' Create Scheme procedure to calculate POSIX.2 checksums
  100.     or other CRCs.
  101.  
  102.   `record.scm' a MITScheme user-definable datatypes package
  103.   `promise.scm' has code from R4RS for supporting DELAY and FORCE.
  104.  
  105.   `repl.scm' has a read-eval-print-loop.
  106.   `defmacex.scm' has defmacro:expand*.
  107.   `mbe.scm' has "Macro by Example" define-syntax.
  108.   `scmacro.scm' is a syntactic closure R4RS macro package.
  109.     r4rsyn.scm, synclo.scm, synrul.scm have syntax definitions
  110.     and support.
  111.   `scmactst.scm' is code for testing SYNTACTIC CLOSURE macros.
  112.   `scainit.scm' is a syntax-case R4RS macro package.
  113.     scaglob.scm scamacr.scm scaoutp.scm scaexpp.scm have
  114.     syntax definitions and support.  `syncase.sh' is a shell
  115.     script for producing the SLIB version from the original.
  116.   `macwork.scm' is a "Macros that work" package.
  117.     mwexpand.scm mwdenote.scm mwsynrul.scm have support.
  118.   `macrotst.scm' is code from R4RS for testing macros.
  119.  
  120.   `values.scm' is multiple values.
  121.   `queue.scm' has queues and stacks.
  122.  
  123.   `object.scm' is an object system.
  124.   `yasyn.scm' defines (syntax-rules) macros for object oriented programming.
  125.   `collect.scm' is collection operators (like CL sequences).
  126.   `priorque.scm' has code and documentation for priority queues.
  127.   `wttree.scm' has weight-balanced trees.
  128.   `wttest.scm' tests weight-balanced trees.
  129.   `process.scm' has multi-processing primitives.
  130.   `array.scm' has multi-dimensional arrays and sub-arrays.
  131.   `arraymap.scm' has array-map!, array-for-each, and array-indexes.
  132.  
  133.   `sort.scm' has sorted?, sort, sort!, merge, and merge!.
  134.   `tsort.scm' has topological-sort.
  135.   `comlist.scm' has many common list and mapping procedures.
  136.   `tree.scm' has functions dealing with trees.
  137.   `chap.scm' has functions which compare and create strings in
  138.     "chapter order".
  139.  
  140.   `sc4opt.scm' has optional rev4 procedures.
  141.   `sc4sc3.scm' has procedures to make a rev3 implementation run rev4
  142.     code. 
  143.   `sc2.scm' has rev2 procedures eliminated in subsequent versions.
  144.   `mularg.scm' redefines - and / to take more than 2 arguments.
  145.   `mulapply.scm' redefines apply to take more than 2 arguments.
  146.   `ratize.scm' has function rationalize from Revised^4 spec.
  147.   `trnscrpt.scm' has transcript-on and transcript-off from Revised^4 spec.
  148.   `withfile.scm' has with-input-from-file and with-output-to-file from R4RS.
  149.   `dynwind.scm' has proposed dynamic-wind from R5RS.
  150.   `eval.scm' has proposed eval with environments from R5RS.
  151.   `dwindtst.scm' has routines for characterizing dynamic-wind.
  152.   `dynamic.scm' has proposed DYNAMIC data type.
  153.   `fluidlet.scm' has fluid-let syntax.
  154.   `struct.scm' has defmacros which implement RECORDS from the book:
  155.     "Essentials of Programming Languages".
  156.   `structure.scm' has syntax-case macros for the same.
  157.   `structst.scm' has test code for struct.scm.
  158.   `byte.scm' has arrays of small integers.
  159.   `nclients' provides a Scheme interface to FTP and WWW Browsers.
  160.  
  161.               INSTALLATION INSTRUCTIONS
  162.  
  163.   Check the manifest in `README' to find a configuration file for your
  164. Scheme implementation.  Initialization files for most IEEE P1178
  165. compliant Scheme Implementations are included with this distribution.
  166.  
  167.   If the Scheme implementation supports `getenv', then the value of the
  168. shell environment variable SCHEME_LIBRARY_PATH will be used for
  169. `(library-vicinity)' if it is defined.  Currently, Chez, Elk,
  170. MITScheme, scheme->c, VSCM, and SCM support `getenv'.  Scheme48
  171. supports `getenv' but does not use it for determining
  172. `library-vicinity'.  (That is done from the Makefile.)
  173.  
  174.   You should check the definitions of `software-type',
  175. `scheme-implementation-version', `implementation-vicinity', and
  176. `library-vicinity' in the initialization file.  There are comments in
  177. the file for how to configure it.
  178.  
  179.   Once this is done you can modify the startup file for your Scheme
  180. implementation to `load' this initialization file.  SLIB is then
  181. installed.
  182.  
  183.   Multiple implementations of Scheme can all use the same SLIB
  184. directory.  Simply configure each implementation's initialization file
  185. as outlined above.
  186.  
  187.   The SCM implementation does not require any initialization file as
  188. SLIB support is already built in to SCM.  See the documentation with
  189. SCM for installation instructions.
  190.  
  191.   SLIB includes methods to create heap images for the VSCM and Scheme48
  192. implementations.  The instructions for creating a VSCM image are in
  193. comments in `vscm.init'.  To make a Scheme48 image for an installation
  194. under `<prefix>', `cd' to the SLIB directory and type `make
  195. prefix=<prefix> slib48'.  To install the image, type `make
  196. prefix=<prefix> install48'.  This will also create a shell script with
  197. the name `slib48' which will invoke the saved image.
  198.  
  199.              PORTING INSTRUCTIONS
  200.  
  201.   If there is no initialization file for your Scheme implementation, you
  202. will have to create one.  Your Scheme implementation must be largely
  203. compliant with
  204.   `IEEE Std 1178-1990',
  205.   `Revised(4) Report on the Algorithmic Language Scheme', or
  206.   `Revised(5) Report on the Algorithmic Language Scheme'
  207. in order to support SLIB.
  208.  
  209.   `Template.scm' is an example configuration file.  The comments inside
  210. will direct you on how to customize it to reflect your system.  Give
  211. your new initialization file the implementation's name with `.init'
  212. appended.  For instance, if you were porting `foo-scheme' then the
  213. initialization file might be called `foo.init'.
  214.  
  215.   Your customized version should then be loaded as part of your scheme
  216. implementation's initialization.  It will load `require.scm' from the
  217. library; this will allow the use of `provide', `provided?', and
  218. `require' along with the "vicinity" functions.  The rest of the
  219. library will then be accessible in a system independent fashion.
  220.  
  221.   Please mail new working configuration files to `jaffer@ai.mit.edu' so
  222. that they can be included in the SLIB distribution.
  223.  
  224.                CODING STANDARDS
  225.  
  226.   All library packages are written in IEEE P1178 Scheme and assume that
  227. a configuration file and `require.scm' package have already been
  228. loaded.  Other versions of Scheme can be supported in library packages
  229. as well by using, for example, `(provided? 'rev3-report)' or `(require
  230. 'rev3-report)'.
  231.  
  232.   `require.scm' defines `*catalog*', an association list of module
  233. names and filenames.  When a new package is added to the library, an
  234. entry should be added to `require.scm'.  Local packages can also be
  235. added to `*catalog*' and even shadow entries already in the table.
  236.  
  237.   The module name and `:' should prefix each symbol defined in the
  238. package.  Definitions for external use should then be exported by having
  239. `(define foo module-name:foo)'.
  240.  
  241.   Submitted packages should not duplicate routines which are already in
  242. SLIB files.  Use `require' to force those features to be supported in
  243. your package.  Care should be taken that there are no circularities in
  244. the `require's and `load's between the library packages.
  245.  
  246.   Documentation should be provided in Emacs Texinfo format if possible,
  247. But documentation must be provided.
  248.